﻿/* ==============================================================================
*
*   Copyright (c) 2010, Pierre Favier
*   All rights reserved.
*
*   NTasking is free software: you can redistribute it and/or modify it
*   under the terms of the GNU General Public License as published by the
*   Free Software Foundation.
*
*   Redistribution and use in source and binary forms, with or without
*   modification, are permitted provided that the following conditions
*   are met:
*
*   -   Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*
*   -   Redistributions in binary form must reproduce the above
*       copyright notice, this list of conditions and the following
*       disclaimer in the documentation and/or other materials
*       provided with the distribution.
*
*   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
*   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
*   BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
*   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
*   TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
*   ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
*   TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
*   THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*   SUCH DAMAGE.
*
* ============================================================================== */

namespace NTasking.Internals
{

    /// <summary>
    /// Define the possible wait states in which a caller thread can be.
    /// </summary>
    internal enum CallerWaitState
    {
        /// <summary>
        /// The currently performed entry call has a timeout condition.
        /// Therefore wait for the call to complete or the timeout has occured
        /// </summary>
        WaitForTimeout,
        /// <summary>
        /// The currently performed entry call has an abortable part which is running.
        /// </summary>
        ExecuteAbortablePart,
        /// <summary>
        /// The currently performed entry call has no cancellation condition.
        /// Therefore wait for the call to complete.
        /// </summary>
        WaitForCompletion,
        /// <summary>
        /// The thread is not currently waiting.
        /// </summary>
        NoWait
    }


    /// <summary>
    /// Define the possible wait states in which a <see cref="Task"/> can be.
    /// </summary>
    internal enum AcceptorWaitState
    {
        /// <summary>
        /// The <see cref="Task"/> is waiting in a select or accept
        /// </summary>
        WaitForCall,
        /// <summary>
        /// The <see cref="Task"/> is waiting in a select with a delay alternative
        /// </summary>
        WaitForCallOrTimeout,
        /// <summary>
        /// The <see cref="Task"/> is waiting in a select with a terminate alternative
        /// </summary>
        WaitForCallOrTerminate,
        /// <summary>
        /// The <see cref="Task"/> is not currently waiting.
        /// </summary>
        NoWait
    }

}
